DescribeAccessGroups
Description
call the DescribeAccessGroups interface to query permission group information.
Request Method
POST
Request Path
/apsara/route/NAS/DescribeAccessGroups
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| PageSize | BODY | integer | No | 2 | the number of permission groups contained in each page. value range: 1~100 default value: 10 |
| PageNumber | BODY | integer | No | 1 | The page number of the list. starting value (default):1 |
| UseUTCDateTime | BODY | boolean | No | true | Specify whether the returned time is expressed in UTC standard format. Value: true (default): The returned time is in UTC standard format. false: The returned time is in a non-UTC standard format. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| AccessGroupName | BODY | string | No | classic-test | permission group name. |
| FileSystemType | BODY | string | No | standard | file system type. default value: standard (general purpose NAS) |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RuleCount | integer | 0 | the number of permission group rules contained in this permission group. |
| AccessGroups | array of accessgroup | No sample value for this parameter. | permission group description information set. |
| AccessGroupType | string | Classic | permission group type. Includes: Vpc: VPC Classic: Classic Network |
| TotalCount | integer | 2 | the total number of permission groups. |
| Description | string | This is a classic test access group~ | permission group description information. |
| PageSize | integer | 2 | the number of permission groups contained in each page. |
| RequestId | string | 2514F97E-FFF0-4A1F-BF04-729CEAC64B6F | request ID. |
| PageNumber | integer | 1 | paging page number of the list. |
| AccessGroup | No sample value for this parameter. | No description for this parameter. | |
| AccessGroupName | string | classic-test | permission group name. |
| MountTargetCount | integer | 0 | the number of mount points to which this permission group applies. |
| ResourceOwnerId | string | 258456 | the ID of the resource. |
Example
Successful Response example
{
"RuleCount":"0",
"AccessGroups":"",
"AccessGroupType":"Classic",
"TotalCount":"2",
"Description":"This is a classic test access group~",
"PageSize":"2",
"RequestId":"2514F97E-FFF0-4A1F-BF04-729CEAC64B6F",
"PageNumber":"1",
"AccessGroup":"",
"AccessGroupName":"classic-test",
"MountTargetCount":"0",
"ResourceOwnerId":"258456"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}